fix(sync): install pg_stat_statements into a named schema and verify through the resolver - #237

Goal

A user following the CI guide should be able to run their migrations afterwards. Today installing pg_stat_statements breaks any project whose migration tool reconciles public, and the failure surfaces as unrelated broken tests. Closes Query-Doctor/Site#4199 on the analyzer side; the docs half and the other producers of the same state are in Query-Doctor/Site#4202.

What

Before: POST /postgres/extensions/pg_stat_statements ran a bare CREATE EXTENSION pg_stat_statements, which lands the extension in public. The extension owns pg_stat_statements_info there and will not let a migration tool drop it, so drizzle-kit push --force aborts half-applied with SQLSTATE 2BP01. Nothing at the point of failure names the extension.

After: the endpoint creates a schema (query_doctor by default, or the schema field in the request body) and puts the extension in it. The response carries the schema back. An extension that was already installed stays where it is, and every read of a public-schema extension logs what is wrong and the ALTER EXTENSION ... SET SCHEMA that fixes it.

A missing extension also reaches the caller as ExtensionNotInstalledError again, so the app shows its install panel instead of raw SQL error text. A resolve now logs the extension and schema it read, so a run that found the statistics can be told from one that found nothing.

The two halves are coupled. The verify step used to probe an unqualified pg_stat_statements, which resolves through the search_path and returns 42P01 for exactly the placement the install now produces — shipping the install alone would report every successful install as a failure.

How

Read src/sync/pg-connector.ts first.

installPgStatStatements() takes { schema }, defaulting to PostgresConnector.EXTENSION_SCHEMA. The name goes through PgIdentifier, so a caller-supplied schema is quoted rather than interpolated.

The verify step resolves the schema from pg_extension JOIN pg_namespace through the new getExtensionSchema(), then probes the view qualified. That helper asks about one named extension rather than reusing getQuerySource(), which matches pg_stat_statements or pg_stat_monitor with no ordering and could otherwise verify an extension this call never installed.

warnIfExtensionIsInPublic() fires from the resolver, so a public install is named at capture time rather than discovered through broken migrations. Its guard is a WeakMap keyed by the Postgres connection: ConnectionManager.getConnectorFor builds a new connector on every poll, so an instance flag would warn every ten seconds, and a process-wide flag would silence every source database after the first.

getRecentQueries() and resetPgStatStatements() classify errors by SQLSTATE through the new isMissingExtensionObject(). They matched the literal relation "pg_stat_statements" does not exist, but every statement they send is schema-qualified, so Postgres names the schema in the message and the match never fired. The codes are 42P01 for a missing relation, 42883 for a missing function, and 3F000 when the schema itself is gone, which is what a qualified function call reports rather than 42883.

src/remote/remote.dto.ts adds InstallPgStatStatementsRequest, which the HTTP route and the websocket controller both decode. An empty schema is a 400 rather than a 500.

The default is query_doctor because a migration tool reconciles the schemas it declares, and no tool declares that one. Any non-public name works.

Databases that already have the extension in public are not migrated. ALTER EXTENSION ... SET SCHEMA needs an ownership the tool may not hold, and relocating a schema object someone else installed is not ours to decide; the warning tells them instead.

Moving the extension trips the schema-drift gate once. The dump records the extension's schemaName and the schemaName of the two views it owns, so a run that installs into query_doctor differs from a baseline captured against public and the gate reports "This PR changes the database schema" on a pull request containing no migration. Measured on a live instance, and reproduced here by diffing the dump against two servers: extensions and views differ by schemaName, and nothing else does (the oid differences the diff also shows are what schemaDigest already ignores). It clears as soon as a run on the default branch writes a new baseline. Whether the drift comparison should ignore objects an extension owns is a separate question, not settled here.

Tests

src/sync/pg-connector.test.ts adds four integration tests against postgres:17: a fresh install lands in query_doctor and leaves nothing named pg_stat_statements* in public; an explicit { schema: "ext" } is honoured; an extension pre-installed in monitoring verifies and reports that schema (this one fails with 42P01 without the resolver change); and a public extension warns once across two connectors over the same connection.

An integration test pins those SQLSTATEs against a real server and asserts the messages do not contain the text the old check looked for. A unit test covers the classifier, including the privilege and syntax codes it must not claim.

Full suite: 44 files, 451 tests, all passing. tsc --noEmit clean.